vinyl

What is vinyl?

The vinyl npm package is a virtual file format used in Node.js streams. It is commonly used in build systems like Gulp to represent files, allowing for easy manipulation and transformation of file contents and metadata.

What are vinyl's main functionalities?

Creating a Vinyl File

This feature allows you to create a new Vinyl file object. The code sample demonstrates how to create a Vinyl file with a specified current working directory, base path, file path, and contents.

const Vinyl = require('vinyl');
const file = new Vinyl({
  cwd: "/",
  base: "/test/",
  path: "/test/file.js",
  contents: Buffer.from("console.log('Hello, world!');")
});
console.log(file);

Reading File Contents

This feature allows you to read the contents of a Vinyl file. The code sample demonstrates how to create a Vinyl file and then read its contents as a string.

const Vinyl = require('vinyl');
const file = new Vinyl({
  cwd: "/",
  base: "/test/",
  path: "/test/file.js",
  contents: Buffer.from("console.log('Hello, world!');")
});
console.log(file.contents.toString());

Checking File Properties

This feature allows you to check various properties of a Vinyl file, such as whether its contents are a buffer, a stream, or null. The code sample demonstrates how to create a Vinyl file and check these properties.

const Vinyl = require('vinyl');
const file = new Vinyl({
  cwd: "/",
  base: "/test/",
  path: "/test/file.js",
  contents: Buffer.from("console.log('Hello, world!');")
});
console.log(file.isBuffer());
console.log(file.isStream());
console.log(file.isNull());

Other packages similar to vinyl

gulp

Gulp is a toolkit for automating painful or time-consuming tasks in your development workflow. It uses Vinyl as its file format, but provides a higher-level API for defining tasks and managing file streams. Compared to Vinyl, Gulp offers more built-in functionality for task automation.

through2

Through2 is a small wrapper around Node.js streams2 Transform to avoid explicit subclassing noise. It is often used in conjunction with Vinyl to create transform streams that can manipulate file contents. While Through2 does not provide a file format like Vinyl, it complements Vinyl by offering a simple way to create transform streams.

vinyl-fs

Vinyl-fs is a file system adapter for Vinyl. It provides methods to read from the file system and write to it, using Vinyl file objects. Compared to Vinyl, vinyl-fs extends its functionality by integrating with the file system, making it easier to read and write files as Vinyl objects.

README

vinyl

Information

Package	vinyl
Description	A virtual file format
Node Version	>= 0.9

What is this?

Read this for more info about how this plays into the grand scheme of things https://medium.com/@eschoff/3828e8126466

File

var File = require('vinyl');

var coffeeFile = new File({
  cwd: "/",
  base: "/test/",
  path: "/test/file.coffee",
  contents: new Buffer("test = 123")
});

constructor(options)

options.cwd

Type: String
Default: process.cwd()

options.base

Used for relative pathing. Typically where a glob starts.

Type: String
Default: options.cwd

options.path

Full path to the file.

Type: String
Default: null

options.stat

The result of an fs.stat call. See fs.Stats for more information.

Type: fs.Stats
Default: null

options.contents

File contents.

Type: Buffer, Stream, or null
Default: null

isBuffer()

Returns true if file.contents is a Buffer.

isStream()

Returns true if file.contents is a Stream.

isNull()

Returns true if file.contents is null.

clone()

Returns a new File object with all attributes cloned. Custom attributes are deep-cloned.

pipe(stream[, opt])

If file.contents is a Buffer, it will write it to the stream.

If file.contents is a Stream, it will pipe it to the stream.

If file.contents is null, it will do nothing.

If opt.end is false, the destination stream will not be ended (same as node core).

Returns the stream.

inspect()

Returns a pretty String interpretation of the File. Useful for console.log.

relative

Returns path.relative for the file base and file path.

Example:

var file = new File({
  cwd: "/",
  base: "/test/",
  path: "/test/file.coffee"
});

console.log(file.relative); // file.coffee